feat: add ndarray/splice
#9807
Draft
feat: add ndarray/splice
#9807
+2,752
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
- task: lint_filenames
status: passed
- task: lint_editorconfig
status: passed
- task: lint_markdown
status: passed
- task: lint_package_json
status: passed
- task: lint_repl_help
status: passed
- task: lint_javascript_src
status: passed
- task: lint_javascript_cli
status: na
- task: lint_javascript_examples
status: passed
- task: lint_javascript_tests
status: passed
- task: lint_javascript_benchmarks
status: passed
- task: lint_python
status: na
- task: lint_r
status: na
- task: lint_c_src
status: na
- task: lint_c_examples
status: na
- task: lint_c_benchmarks
status: na
- task: lint_c_tests_fixtures
status: na
- task: lint_shell
status: na
- task: lint_typescript_declarations
status: passed
- task: lint_typescript_tests
status: passed
- task: lint_license_headers
status: passed
---
headlessNode
added
Feature
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
reviewed
Jan 27, 2026
|
|
||
| # splice | ||
|
|
||
| > Return an [`ndarray`][@stdlib/ndarray/ctor] where elements of an input [`ndarray`][@stdlib/ndarray/ctor] are replaced or removed along a specific dimension |
Member
There was a problem hiding this comment.
Suggested change
| > Return an [`ndarray`][@stdlib/ndarray/ctor] where elements of an input [`ndarray`][@stdlib/ndarray/ctor] are replaced or removed along a specific dimension | |
| > Return an [`ndarray`][@stdlib/ndarray/ctor] where elements of an input [`ndarray`][@stdlib/ndarray/ctor] are replaced or removed along a specific dimension. |
kgryte
reviewed
Jan 27, 2026
|
|
||
| The function accepts the following `options`: | ||
|
|
||
| - **dim**: dimension along which to perform the operation. Must be a negative integer. The index is resolved relative to the last dimension, with the last dimension corresponding to the value `-1`. Default: `-1`. |
Member
There was a problem hiding this comment.
dim should be allowed to be any integer, not just negative integers, as dim unambiguously applies to x.
kgryte
reviewed
Jan 27, 2026
| * Returns an ndarray where the elements of an input ndarray are replaced or removed along a specific dimension. | ||
| * | ||
| * @param {ndarray} x - input array | ||
| * @param {(Slice|integer)} s - slice object or an integer |
Member
There was a problem hiding this comment.
Suggested change
| * @param {(Slice|integer)} s - slice object or an integer | |
| * @param {(Slice|integer|null|void)} s - slice object or an integer |
kgryte
reviewed
Jan 27, 2026
| throw new TypeError( format( 'invalid argument. Values argument must be an ndarray. Value: `%s`.', v ) ); | ||
| } | ||
| hasValues = true; | ||
| } else if ( nargs === 3 ) { // Case: splice( x, s, ???) |
Member
There was a problem hiding this comment.
Suggested change
| } else if ( nargs === 3 ) { // Case: splice( x, s, ???) | |
| } else if ( nargs === 3 ) { // Case: splice( x, s, ??? ) |
kgryte
reviewed
Jan 27, 2026
| var splice = require( '@stdlib/ndarray/splice' ); | ||
| ``` | ||
|
|
||
| #### splice( x, slice\[, values\[, options]] ) |
Member
There was a problem hiding this comment.
Suggested change
| #### splice( x, slice\[, values\[, options]] ) | |
| #### splice( x, slices\[, values\[, options]] ) |
where slices is an array of slices and values is an array of ndarrays, having a length equal to slices?
Member
There was a problem hiding this comment.
splice( x, [ s1 ], [ values1 ], opts );
splice( x, s1, values1, opts ); // ^^^ shorthand for this common use case
splice( x, [ s1, s2 ], [ values1, values2 ], opts ); // if provided more than one slice, always need to provide an array of ndarrays for `values`
Member
There was a problem hiding this comment.
When supporting multiple slice objects,
- need to validate that the slice regions do not overlap.
- need to sort the slice regions (and thus values) based on the slice
start.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes. report:
Resolves stdlib-js/metr-issue-tracker#135.
Description
This pull request:
ndarray/spliceRelated Issues
This pull request has the following related issues:
ndarray/splicemetr-issue-tracker#135Questions
No.
Other
No.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
{{TODO: add disclosure if applicable}}
@stdlib-js/reviewers